<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: include/pico/time_adapter.h Source File</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.1.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('time__adapter_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle"><div class="title">time_adapter.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2024 Raspberry Pi (Trading) Ltd.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * SPDX-License-Identifier: BSD-3-Clause</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> */</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef _PICO_TIME_ADAPTER_H</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define _PICO_TIME_ADAPTER_H</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &quot;<a class="code" href="irq_8h.html">hardware/irq.h</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &quot;<a class="code" href="rp2__common_2hardware__timer_2include_2hardware_2timer_8h.html">hardware/timer.h</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#include &quot;pico/assert.h&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#define TA_NUM_TIMERS NUM_GENERIC_TIMERS</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="preprocessor">#define TA_NUM_TIMER_ALARMS NUM_ALARMS</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="preprocessor">#define timer_hw_from_timer(t) ((timer_hw_t *)(t))</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ta_force_irq(alarm_pool_timer_t *timer, uint alarm_num) {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span>    <a class="code hl_function" href="group__hardware__base.html#ga625e737a57f12211cf1f634ca5095ae4">hw_set_bits</a>(&amp;timer_hw_from_timer(timer)-&gt;intf, 1u &lt;&lt; alarm_num);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>}</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ta_clear_force_irq(alarm_pool_timer_t *timer, uint alarm_num) {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>    <a class="code hl_function" href="group__hardware__base.html#gafd1c089df868d987daf95870b501c2ed">hw_clear_bits</a>(&amp;timer_hw_from_timer(timer)-&gt;intf, 1u &lt;&lt; alarm_num);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>}</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ta_clear_irq(alarm_pool_timer_t *timer, uint alarm_num) {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>    timer_hw_from_timer(timer)-&gt;intr = 1u &lt;&lt; alarm_num;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>}</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keyword">static</span> <span class="keyword">inline</span> alarm_pool_timer_t *ta_from_current_irq(uint *alarm_num) {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>    uint irq_num = <a class="code hl_function" href="group__pico__platform.html#ga1ebeac462e038d7e2ce341df8054f894">__get_current_exception</a>() - VTABLE_FIRST_IRQ;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>    alarm_pool_timer_t *timer = <a class="code hl_function" href="group__hardware__timer.html#ga1a268fc4a0ad01d2879a7a7334cf9984">timer_get_instance</a>(<a class="code hl_define" href="group__hardware__timer.html#gab3d512da219783a171937d52f17c19d4">TIMER_NUM_FROM_IRQ</a>(irq_num));</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    *alarm_num = <a class="code hl_define" href="group__hardware__timer.html#gad96d6d69599253d1880356a4d71ecf19">TIMER_ALARM_NUM_FROM_IRQ</a>(irq_num);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>    <span class="keywordflow">return</span> timer;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>}</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ta_set_timeout(alarm_pool_timer_t *timer, uint alarm_num, int64_t target) {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>    <span class="comment">// We never want to set the timeout to be later than our current one.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span>    uint32_t current = <a class="code hl_function" href="group__hardware__timer.html#ga2b3cd8f1226824b3a85fb2bca66e70fd">timer_time_us_32</a>(timer_hw_from_timer(timer));</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span>    uint32_t time_til_target = (uint32_t) target - current;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>    uint32_t time_til_alarm = timer_hw_from_timer(timer)-&gt;alarm[alarm_num] - current;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>    <span class="comment">// Note: we are only dealing with the low 32 bits of the timer values,</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>    <span class="comment">// so there is some opportunity to make wrap-around errors.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span>    <span class="comment">//</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>    <span class="comment">// 1. If we just passed the alarm time, then time_til_alarm will be high, meaning we will</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>    <span class="comment">//    likely do the update, but this is OK since the alarm will have just fired</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>    <span class="comment">// 2. If we just passed the target time, then time_til_target will be high, meaning we will</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>    <span class="comment">//    likely not do the update, but this is OK since the caller who has the full 64 bits</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>    <span class="comment">//    must check if the target time has passed when we return anyway to avoid races.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>    <span class="keywordflow">if</span> (time_til_target &lt; time_til_alarm) {</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>        timer_hw_from_timer(timer)-&gt;alarm[alarm_num] = (uint32_t) target;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span>    }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span>}</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">bool</span> ta_wakes_up_on_or_before(alarm_pool_timer_t *timer, uint alarm_num, int64_t target) {</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>    uint32_t current = <a class="code hl_function" href="group__hardware__timer.html#ga2b3cd8f1226824b3a85fb2bca66e70fd">timer_time_us_32</a>(timer_hw_from_timer(timer));</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>    uint32_t time_til_target = (uint32_t) target - current;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span>    uint32_t time_til_alarm = timer_hw_from_timer(timer)-&gt;alarm[alarm_num] - current;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>    <span class="keywordflow">return</span> time_til_alarm &lt;= time_til_target;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>}</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="keyword">static</span> <span class="keyword">inline</span> uint64_t ta_time_us_64(alarm_pool_timer_t *timer) {</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>    <span class="keywordflow">return</span> <a class="code hl_function" href="group__hardware__timer.html#ga937b4fb64eb4c7cc59464b38365d72d9">timer_time_us_64</a>(timer_hw_from_timer(timer));</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>}</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ta_enable_irq_handler(alarm_pool_timer_t *timer, uint alarm_num, <a class="code hl_typedef" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> irq_handler) {</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>    <span class="comment">// disarm the timer</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>    uint irq_num = <a class="code hl_function" href="group__hardware__timer.html#ga6465bf6a18ece735e61d378539cde0ec">timer_hardware_alarm_get_irq_num</a>(timer, alarm_num);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>    timer_hw_from_timer(timer)-&gt;armed = 1u &lt;&lt; alarm_num;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>    <a class="code hl_function" href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f">irq_set_exclusive_handler</a>(irq_num, irq_handler);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    <a class="code hl_function" href="group__hardware__irq.html#ga7c7167f643c6898b758340ce59d333d9">irq_set_enabled</a>(irq_num, <span class="keyword">true</span>);</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>    <a class="code hl_function" href="group__hardware__base.html#ga625e737a57f12211cf1f634ca5095ae4">hw_set_bits</a>(&amp;timer_hw_from_timer(timer)-&gt;inte, 1u &lt;&lt; alarm_num);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>}</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ta_disable_irq_handler(alarm_pool_timer_t *timer, uint alarm_num, <a class="code hl_typedef" href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a> irq_handler) {</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>    uint irq_num = <a class="code hl_function" href="group__hardware__timer.html#ga6465bf6a18ece735e61d378539cde0ec">timer_hardware_alarm_get_irq_num</a>(timer, alarm_num);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>    <a class="code hl_function" href="group__hardware__base.html#gafd1c089df868d987daf95870b501c2ed">hw_clear_bits</a>(&amp;timer_hw_from_timer(timer)-&gt;inte, 1u &lt;&lt; alarm_num);</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>    <a class="code hl_function" href="group__hardware__irq.html#ga7c7167f643c6898b758340ce59d333d9">irq_set_enabled</a>(irq_num, <span class="keyword">true</span>);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span>    <a class="code hl_function" href="group__hardware__irq.html#gadfd3308952d41ee91671ae098b867a90">irq_remove_handler</a>(irq_num, irq_handler);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>    <a class="code hl_function" href="group__hardware__timer.html#ga0d9ea3c5f1d4ea94812b338afbcef7e5">hardware_alarm_unclaim</a>(alarm_num);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>}</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ta_hardware_alarm_claim(alarm_pool_timer_t *timer, uint hardware_alaram_num) {</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>    <a class="code hl_function" href="group__hardware__timer.html#gaa4e5b9946e1ce19788b46b8bf9987a4b">timer_hardware_alarm_claim</a>(timer_hw_from_timer(timer), hardware_alaram_num);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>}</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> ta_hardware_alarm_claim_unused(alarm_pool_timer_t *timer, <span class="keywordtype">bool</span> required) {</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>    <span class="keywordflow">return</span> <a class="code hl_function" href="group__hardware__timer.html#ga8942fc87edfb495a2dd75a4703700642">timer_hardware_alarm_claim_unused</a>(timer, required);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>}</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="keyword">static</span> <span class="keyword">inline</span> alarm_pool_timer_t *ta_timer_instance(uint timer_num) {</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>    <span class="keywordflow">return</span> <a class="code hl_function" href="group__hardware__timer.html#ga1a268fc4a0ad01d2879a7a7334cf9984">timer_get_instance</a>(timer_num);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>}</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="keyword">static</span> <span class="keyword">inline</span> uint ta_timer_num(alarm_pool_timer_t *timer) {</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>    <span class="keywordflow">return</span> <a class="code hl_function" href="group__hardware__timer.html#ga6e6a907da0b44a8fb2db2277ad05079c">timer_get_index</a>(timer_hw_from_timer(timer));</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>}</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="keyword">static</span> <span class="keyword">inline</span> alarm_pool_timer_t *ta_default_timer_instance(<span class="keywordtype">void</span>) {</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>    <span class="keywordflow">return</span> <a class="code hl_define" href="group__hardware__timer.html#ga929d2a5b281a0f0321a4273f63ca9ce3">PICO_DEFAULT_TIMER_INSTANCE</a>();</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>}</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="agroup__hardware__base_html_ga625e737a57f12211cf1f634ca5095ae4"><div class="ttname"><a href="group__hardware__base.html#ga625e737a57f12211cf1f634ca5095ae4">hw_set_bits</a></div><div class="ttdeci">static __force_inline void hw_set_bits(io_rw_32 *addr, uint32_t mask)</div><div class="ttdoc">Atomically set the specified bits to 1 in a HW register.</div><div class="ttdef"><b>Definition:</b> address_mapped.h:135</div></div>
<div class="ttc" id="agroup__hardware__base_html_gafd1c089df868d987daf95870b501c2ed"><div class="ttname"><a href="group__hardware__base.html#gafd1c089df868d987daf95870b501c2ed">hw_clear_bits</a></div><div class="ttdeci">static __force_inline void hw_clear_bits(io_rw_32 *addr, uint32_t mask)</div><div class="ttdoc">Atomically clear the specified bits to 0 in a HW register.</div><div class="ttdef"><b>Definition:</b> address_mapped.h:145</div></div>
<div class="ttc" id="agroup__hardware__irq_html_ga7c7167f643c6898b758340ce59d333d9"><div class="ttname"><a href="group__hardware__irq.html#ga7c7167f643c6898b758340ce59d333d9">irq_set_enabled</a></div><div class="ttdeci">void irq_set_enabled(uint num, bool enabled)</div><div class="ttdoc">Enable or disable a specific interrupt on the executing core.</div><div class="ttdef"><b>Definition:</b> irq.c:61</div></div>
<div class="ttc" id="agroup__hardware__irq_html_ga8478ee26cc144e947ccd75b0169059a6"><div class="ttname"><a href="group__hardware__irq.html#ga8478ee26cc144e947ccd75b0169059a6">irq_handler_t</a></div><div class="ttdeci">void(* irq_handler_t)(void)</div><div class="ttdoc">Interrupt handler function type.</div><div class="ttdef"><b>Definition:</b> irq.h:195</div></div>
<div class="ttc" id="agroup__hardware__irq_html_gadfd3308952d41ee91671ae098b867a90"><div class="ttname"><a href="group__hardware__irq.html#gadfd3308952d41ee91671ae098b867a90">irq_remove_handler</a></div><div class="ttdeci">void irq_remove_handler(uint num, irq_handler_t handler)</div><div class="ttdoc">Remove a specific interrupt handler for the given irq number on the executing core.</div><div class="ttdef"><b>Definition:</b> irq.c:470</div></div>
<div class="ttc" id="agroup__hardware__irq_html_gafffd448ba2d2eef5b355b88180aefe7f"><div class="ttname"><a href="group__hardware__irq.html#gafffd448ba2d2eef5b355b88180aefe7f">irq_set_exclusive_handler</a></div><div class="ttdeci">void irq_set_exclusive_handler(uint num, irq_handler_t handler)</div><div class="ttdoc">Set an exclusive interrupt handler for an interrupt on the executing core.</div><div class="ttdef"><b>Definition:</b> irq.c:219</div></div>
<div class="ttc" id="agroup__hardware__timer_html_ga0d9ea3c5f1d4ea94812b338afbcef7e5"><div class="ttname"><a href="group__hardware__timer.html#ga0d9ea3c5f1d4ea94812b338afbcef7e5">hardware_alarm_unclaim</a></div><div class="ttdeci">void hardware_alarm_unclaim(uint alarm_num)</div><div class="ttdoc">cooperatively release the claim on use of this hardware alarm_num on the default timer instance</div><div class="ttdef"><b>Definition:</b> timer.c:35</div></div>
<div class="ttc" id="agroup__hardware__timer_html_ga1a268fc4a0ad01d2879a7a7334cf9984"><div class="ttname"><a href="group__hardware__timer.html#ga1a268fc4a0ad01d2879a7a7334cf9984">timer_get_instance</a></div><div class="ttdeci">static timer_hw_t * timer_get_instance(uint timer_num)</div><div class="ttdoc">Returns the timer instance with the given timer number.</div><div class="ttdef"><b>Definition:</b> timer.h:590</div></div>
<div class="ttc" id="agroup__hardware__timer_html_ga2b3cd8f1226824b3a85fb2bca66e70fd"><div class="ttname"><a href="group__hardware__timer.html#ga2b3cd8f1226824b3a85fb2bca66e70fd">timer_time_us_32</a></div><div class="ttdeci">static uint32_t timer_time_us_32(timer_hw_t *timer)</div><div class="ttdoc">Return a 32 bit timestamp value in microseconds for a given timer instance.</div><div class="ttdef"><b>Definition:</b> timer.h:202</div></div>
<div class="ttc" id="agroup__hardware__timer_html_ga6465bf6a18ece735e61d378539cde0ec"><div class="ttname"><a href="group__hardware__timer.html#ga6465bf6a18ece735e61d378539cde0ec">timer_hardware_alarm_get_irq_num</a></div><div class="ttdeci">static uint timer_hardware_alarm_get_irq_num(timer_hw_t *timer, uint alarm_num)</div><div class="ttdoc">Returns the irq_num_t for the alarm interrupt from the given alarm on the given timer instance.</div><div class="ttdef"><b>Definition:</b> timer.h:557</div></div>
<div class="ttc" id="agroup__hardware__timer_html_ga6e6a907da0b44a8fb2db2277ad05079c"><div class="ttname"><a href="group__hardware__timer.html#ga6e6a907da0b44a8fb2db2277ad05079c">timer_get_index</a></div><div class="ttdeci">static uint timer_get_index(timer_hw_t *timer)</div><div class="ttdoc">Returns the timer number for a timer instance.</div><div class="ttdef"><b>Definition:</b> timer.h:579</div></div>
<div class="ttc" id="agroup__hardware__timer_html_ga8942fc87edfb495a2dd75a4703700642"><div class="ttname"><a href="group__hardware__timer.html#ga8942fc87edfb495a2dd75a4703700642">timer_hardware_alarm_claim_unused</a></div><div class="ttdeci">int timer_hardware_alarm_claim_unused(timer_hw_t *timer, bool required)</div><div class="ttdoc">cooperatively claim the use of a hardware alarm_num on the given timer instance</div><div class="ttdef"><b>Definition:</b> timer.c:48</div></div>
<div class="ttc" id="agroup__hardware__timer_html_ga929d2a5b281a0f0321a4273f63ca9ce3"><div class="ttname"><a href="group__hardware__timer.html#ga929d2a5b281a0f0321a4273f63ca9ce3">PICO_DEFAULT_TIMER_INSTANCE</a></div><div class="ttdeci">#define PICO_DEFAULT_TIMER_INSTANCE()</div><div class="ttdoc">Returns the default timer instance on the platform based on the setting of PICO_DEFAULT_TIMER.</div><div class="ttdef"><b>Definition:</b> timer.h:182</div></div>
<div class="ttc" id="agroup__hardware__timer_html_ga937b4fb64eb4c7cc59464b38365d72d9"><div class="ttname"><a href="group__hardware__timer.html#ga937b4fb64eb4c7cc59464b38365d72d9">timer_time_us_64</a></div><div class="ttdeci">uint64_t timer_time_us_64(timer_hw_t *timer)</div><div class="ttdoc">Return the current 64 bit timestamp value in microseconds for a given timer instance.</div><div class="ttdef"><b>Definition:</b> timer.c:57</div></div>
<div class="ttc" id="agroup__hardware__timer_html_gaa4e5b9946e1ce19788b46b8bf9987a4b"><div class="ttname"><a href="group__hardware__timer.html#gaa4e5b9946e1ce19788b46b8bf9987a4b">timer_hardware_alarm_claim</a></div><div class="ttdeci">void timer_hardware_alarm_claim(timer_hw_t *timer, uint alarm_num)</div><div class="ttdoc">cooperatively claim the use of this hardware alarm_num on the given timer instance</div><div class="ttdef"><b>Definition:</b> timer.c:21</div></div>
<div class="ttc" id="agroup__hardware__timer_html_gab3d512da219783a171937d52f17c19d4"><div class="ttname"><a href="group__hardware__timer.html#gab3d512da219783a171937d52f17c19d4">TIMER_NUM_FROM_IRQ</a></div><div class="ttdeci">#define TIMER_NUM_FROM_IRQ(irq_num)</div><div class="ttdoc">Returns the alarm number from an irq_num_t. See TIMER_INSTANCE_NUM_FROM_IRQ to get the alarm number.</div><div class="ttdef"><b>Definition:</b> timer.h:147</div></div>
<div class="ttc" id="agroup__hardware__timer_html_gad96d6d69599253d1880356a4d71ecf19"><div class="ttname"><a href="group__hardware__timer.html#gad96d6d69599253d1880356a4d71ecf19">TIMER_ALARM_NUM_FROM_IRQ</a></div><div class="ttdeci">#define TIMER_ALARM_NUM_FROM_IRQ(irq_num)</div><div class="ttdoc">Returns the alarm number from an irq_num_t. See TIMER_INSTANCE_NUM_FROM_IRQ to get the timer instance...</div><div class="ttdef"><b>Definition:</b> timer.h:129</div></div>
<div class="ttc" id="agroup__pico__platform_html_ga1ebeac462e038d7e2ce341df8054f894"><div class="ttname"><a href="group__pico__platform.html#ga1ebeac462e038d7e2ce341df8054f894">__get_current_exception</a></div><div class="ttdeci">static __force_inline uint __get_current_exception(void)</div><div class="ttdoc">Get the current exception level on this core.</div><div class="ttdef"><b>Definition:</b> platform.h:169</div></div>
<div class="ttc" id="airq_8h_html"><div class="ttname"><a href="irq_8h.html">irq.h</a></div></div>
<div class="ttc" id="arp2__common_2hardware__timer_2include_2hardware_2timer_8h_html"><div class="ttname"><a href="rp2__common_2hardware__timer_2include_2hardware_2timer_8h.html">timer.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>